Management API

Base Resource URL:


                    https://[server-name]/api/v01/merchants/[merchant-code]/profiles/gift-realtime/sts

Description:

Settings for processing of gift/loyalty cards in realtime mode through STS.

Supported Actions:

copyFrom

Method: GET	Implicit: No	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Copies profile settings from another merchant's profile definition.

copyTo

Method: GET	Implicit: No	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Copies profile settings of the selected merchant into corresponding profile settings of the specified merchants/sub-merchants.

delete

Method: DELETE	Implicit: Yes	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Deletes profile settings.

load

Method: GET	Implicit: Yes	Returns: STSGiftRealtimeProviderProfile *
Consumes: xurl		Produces: json, xml

Returns current profile settings.

modify

Method: POST	Implicit: Yes	Returns: STSGiftRealtimeProviderProfile *
Consumes: json, xml, xurl		Produces: json, xml

Creates new or updates an existing Provider Profile for real-time Heartland Portico processing.

Parameters:

#	Name	Type	Required	Default	Description
01	profile	STSGiftRealtimeProviderProfile *	Yes		Updated profile information. Configuration settings for STS GIFTRealtime Provider Profile